package gsar.client;

/*
Copyright (c) 2009, Eric Eaton, University of Maryland Baltimore County
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the University of Maryland Baltimore County nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

/** Represents the status information for the agent's last action
 * @author Eric Eaton
 */
public class GWActionStatus {
	
	/** the action itself */
	private GWAction m_action = null;
	
	/** the timestamp of the action */
	private int m_timestamp;
	
	/** The status of the action -- the format of this will vary depending
	 *  on the specific action.  See the GSAR implementation instructions and
	 *  publications for more details.
	 */
	private Object m_status;

	
	/** Constructor
	 * @param action  the action
	 * @param timestamp the timestep of the action
	 * @param status the status of the action.  The format of this will vary
	 *               depending on the specific action.  See the GSAR implementation
	 *               instructions and publications for more details.
	 */
	public GWActionStatus(GWAction action, int timestamp, Object status) {
		if (action == null)
			throw new IllegalArgumentException("action cannot be null");
		if (status == null)
			throw new IllegalArgumentException("status cannot be null");
		m_action = action;
		m_timestamp = timestamp;
		m_status = status;
	}
	
	/** Gets the action.
	 * @return the action.
	 */
	public GWAction getAction() { return m_action; }
	
	/** Gets the timestep of the action.
	 * @return the timestep
	 */
	public int getTimestamp() { return m_timestamp; }
	
	/** Gets the status of the action.
	 * @return the status of the action.  The format of this will vary
	 *         depending on the specific action.  See the GSAR implementation
	 *         instructions and publications for more details.
	 */
	public Object getStatus() { return m_status; }
	
	public String toString() {
		String str = m_timestamp+":"+m_action+"("+m_status+")";
		return str;
	}
}
